Vcenter Host Entropy ExternalPool Info

Vcenter Host Entropy ExternalPool Info
Vcenter Host Entropy ExternalPool Info

The Vcenter Host Entropy ExternalPool Info schema contains entropy pool information on the ESX host. It provides external entropy pool details as well as timeout in seconds within which client has to keep calling GET /vcenter/host/{host}/entropy/external-pool operation.

Client has to monitor Info.currentlyAvailable parameter. Before the entropy level goes down below a threshold value the client has to send entropy data by calling POST /vcenter/host/{host}/entropy/external-pool?action=add operation.

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "status": "string",
    "capacity": 0,
    "currently_available": 0,
    "low_watermark": 0,
    "inactive_source_timeout": 0
}
string
status
Required

This flag indicates entropy service is enabled or not in a ESX host.

For more information see: Vcenter Host Entropy ExternalPool Status.

This property was added in vSphere API 8.0.1.0.

integer As int64 As int64
capacity
Optional

Capacity of external entropy pool in bytes.

This property was added in vSphere API 8.0.1.0.

This property is optional and it is only relevant when the value of status is Vcenter Host Entropy ExternalPool Status.ENABLED.

integer As int64 As int64
currently_available
Optional

Currently available amount of entropy in bytes in the external entropy pool.

This property was added in vSphere API 8.0.1.0.

This property is optional and it is only relevant when the value of status is Vcenter Host Entropy ExternalPool Status.ENABLED.

integer As int64 As int64
low_watermark
Optional

A threshold value in bytes. An audit record will be logged when Vcenter Host Entropy ExternalPool Info.currently_available drops below this value.

This property was added in vSphere API 8.0.1.0.

This property is optional and it is only relevant when the value of status is Vcenter Host Entropy ExternalPool Status.ENABLED.

integer As int64 As int64
inactive_source_timeout
Optional

A timeout period in seconds within which the client must call GET /vcenter/host/{host}/entropy/external-pool operation or POST /vcenter/host/{host}/entropy/external-pool?action=add operation. If no call is received before the timeout lapses an audit record will be created.

This timeout is used to detect that connection with the client is lost.

This property was added in vSphere API 8.0.1.0.

This property is optional and it is only relevant when the value of status is Vcenter Host Entropy ExternalPool Status.ENABLED.

Returned By